Parent | Child | Previous | Next
 
Xbasic

SQL::ResultSetFormatData Method

This function is deprecated and may be removed in the future. Use a5_mergeDataIntoTemplate() instead.

Syntax

Formatted_Data as C = FormatData(DataToFormat as N [, Format as C [, UserContext as P [,FirstRowOnPage as N]]])

Formatted_Data as C = FormatData(DataToFormat as C [, Format as C [, UserContext as P [,FirstRowOnPage as N]]])

Formatted_Data as C = FormatData(DataToFormat as SQL::DataTypeInfo [, Format as C [, UserContext as P [,FirstRowOnPage as N]]])

Arguments

DataToFormatNumeric Character SQL::DataTypeInfo

The number of the column in the selected table, the name of the field in the selected table, or a SQL::DataTypeInfo object created with a DIM statement.

FormatCharacter

UserContextPointer

The user context is passed into the evaluation of the expression when data is formatted.

FirstRowOnPageNumeric

The first row of data to include.

Returns

Formatted_Data

A string representation of a data value in a result set row.

Description

Format the data for the column name, index or definition specified.

Discussion

The SQL::ResultSet FormatData() method returns a string representation of a data value in a result set row depending on the contents of the two properties (see below). The FormatData() method works as follows:

  1. If the caller requests a format, FormatData() looks to see if the format is defined. If so, it evaluates the right-hand-side expression and returns the result.

  2. If the caller does not request a format, and a default (unnamed format) exists, FormatData() evaluates the default expression and returns the result.

  3. If the type of the data is numeric and a DisplayFormat is defined, FormatData() uses that format when calling the str() function.

  4. If no condition above is satisfied, FormatData() converts the value to the default string format and returns the result.

Property
Description
.NamedFormatExpressions

This property is a CR-LF delimited list of Xbasic expressions. One of those expressions can be unnamed, subsequent expressions should be prefixed with name= where "name" is a unique name for the expression. The Xbasic expression part of each line is executed in the context of a generated function that has three arguments:

Argument
Description
.CurrentRow

A SQL::Row object

.ColumnDefinition

A SQL::DataTypeInfo object.

.Context

This value is provided by the caller and typically will be a dot variable with additional contextual information required by the expression.

.DisplayFormat

Used to specify a numeric format (where appropriate) using the values you would pass to the Xbasic str() function.

.ExternalFileNameExpression

If this string is defined when FormatData()is called:

1. FormatData() evaluates this expression to get the name of the file to create.

2. FormatData() stores the data in the file named by the expression. If the data is binary, the function stores it in binary form. The function stores all other values in string form.

See Also